<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>uartns550: Uartns550_v3_3</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">uartns550
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">Uartns550_v3_3</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550_buffer.html">XUartNs550Buffer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550_format.html">XUartNs550Format</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550_stats.html">XUartNs550Stats</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga58ff500307c70fda263888b18fc6389c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>(BaseAddress,  RegOffset)&#160;&#160;&#160;Xil_In32((BaseAddress) + (RegOffset))</td></tr>
<tr class="separator:ga58ff500307c70fda263888b18fc6389c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae648146666080fdac4f6949b6ed3101a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>(BaseAddress,  RegOffset,  RegisterValue)&#160;&#160;&#160;Xil_Out32((BaseAddress) + (RegOffset), (RegisterValue))</td></tr>
<tr class="separator:gae648146666080fdac4f6949b6ed3101a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5bbc90c39e15adea04c63548dd537cc5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>(BaseAddress)  &#160;&#160;&#160;<a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>((BaseAddress), <a class="el" href="group__uartns550__v3__3.html#ga9cb658f2d8ea9eb438ee626a74ab65ef">XUN_LSR_OFFSET</a>)</td></tr>
<tr class="separator:ga5bbc90c39e15adea04c63548dd537cc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab9ba96c18cb50a8ab5873d781b4ee94e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gab9ba96c18cb50a8ab5873d781b4ee94e">XUartNs550_GetLineControlReg</a>(BaseAddress)&#160;&#160;&#160;<a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>((BaseAddress), <a class="el" href="group__uartns550__v3__3.html#ga50bcaf32aedaf4476931b898961a533f">XUN_LCR_OFFSET</a>)</td></tr>
<tr class="separator:gab9ba96c18cb50a8ab5873d781b4ee94e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f3ff99ca70dfe6c715cbbfdd9742230"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga4f3ff99ca70dfe6c715cbbfdd9742230">XUartNs550_SetLineControlReg</a>(BaseAddress,  RegisterValue)&#160;&#160;&#160;<a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>((BaseAddress), <a class="el" href="group__uartns550__v3__3.html#ga50bcaf32aedaf4476931b898961a533f">XUN_LCR_OFFSET</a>, (RegisterValue))</td></tr>
<tr class="separator:ga4f3ff99ca70dfe6c715cbbfdd9742230"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga24622c1399f2cbab46e9dda140ef4aa0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga24622c1399f2cbab46e9dda140ef4aa0">XUartNs550_EnableIntr</a>(BaseAddress)</td></tr>
<tr class="separator:ga24622c1399f2cbab46e9dda140ef4aa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9039b3a4a9852fa556e522976edd1288"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga9039b3a4a9852fa556e522976edd1288">XUartNs550_DisableIntr</a>(BaseAddress)</td></tr>
<tr class="separator:ga9039b3a4a9852fa556e522976edd1288"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga941188ffba023576548effef6ccb0707"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga941188ffba023576548effef6ccb0707">XUartNs550_IsReceiveData</a>(BaseAddress)&#160;&#160;&#160;(<a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>(BaseAddress) &amp; <a class="el" href="group__uartns550__v3__3.html#ga64e43cf523785c523618adc1f046370f">XUN_LSR_DATA_READY</a>)</td></tr>
<tr class="separator:ga941188ffba023576548effef6ccb0707"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabae5b671e19c043af9e1c76e183acb60"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gabae5b671e19c043af9e1c76e183acb60">XUartNs550_IsTransmitEmpty</a>(BaseAddress)&#160;&#160;&#160;(<a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>(BaseAddress) &amp; <a class="el" href="group__uartns550__v3__3.html#gacfc60ddcada499862b482041805b1f03">XUN_LSR_TX_BUFFER_EMPTY</a>)</td></tr>
<tr class="separator:gabae5b671e19c043af9e1c76e183acb60"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga21a8c40dd3f55a6a052d91bfe2ad8228"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga21a8c40dd3f55a6a052d91bfe2ad8228">XUartNs550_Handler</a>) (void *CallBackRef, u32 Event, unsigned int EventData)</td></tr>
<tr class="separator:ga21a8c40dd3f55a6a052d91bfe2ad8228"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga37a67d6e3901ba6bee3df7c51dab093b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a> *Config, u32 EffectiveAddr)</td></tr>
<tr class="separator:ga37a67d6e3901ba6bee3df7c51dab093b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga421921af6a8df7c51ddbfa5d2301ad1b"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u8 *BufferPtr, unsigned int NumBytes)</td></tr>
<tr class="separator:ga421921af6a8df7c51ddbfa5d2301ad1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga35fc171801e394fce29cbcb09dc1ff99"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u8 *BufferPtr, unsigned int NumBytes)</td></tr>
<tr class="separator:ga35fc171801e394fce29cbcb09dc1ff99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9046228564fdafeb5715dce1c0b46766"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga9046228564fdafeb5715dce1c0b46766"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6df754edf91aea638537a15536d4d34e"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga6df754edf91aea638537a15536d4d34e">XUartNs550_ReceiveBuffer</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga6df754edf91aea638537a15536d4d34e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga97009bf7b2508c14225b0d5835c256d0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga97009bf7b2508c14225b0d5835c256d0">XUartNs550_Initialize</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="separator:ga97009bf7b2508c14225b0d5835c256d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c5e715e9e90bd93e68c47e1cd398be5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga2c5e715e9e90bd93e68c47e1cd398be5">XUartNs550_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="separator:ga2c5e715e9e90bd93e68c47e1cd398be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2270082fbb7d7b2c32bd9208dae5be3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gac2270082fbb7d7b2c32bd9208dae5be3">XUartNs550_SetOptions</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u16 Options)</td></tr>
<tr class="separator:gac2270082fbb7d7b2c32bd9208dae5be3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga120797e7b4fc719c827c4378e387efe4"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga120797e7b4fc719c827c4378e387efe4">XUartNs550_GetOptions</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga120797e7b4fc719c827c4378e387efe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaedd1056b9f1283ee15c1a3c349acb845"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, u8 TriggerLevel)</td></tr>
<tr class="separator:gaedd1056b9f1283ee15c1a3c349acb845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f7c185a91f28f3490fa8ef71dab1059"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga4f7c185a91f28f3490fa8ef71dab1059">XUartNs550_GetFifoThreshold</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga4f7c185a91f28f3490fa8ef71dab1059"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab822fbaed4a57714779e35b6be6f090"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gaab822fbaed4a57714779e35b6be6f090">XUartNs550_IsSending</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:gaab822fbaed4a57714779e35b6be6f090"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab5c78c74113daef4f74aefbc57e92b3a"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gab5c78c74113daef4f74aefbc57e92b3a">XUartNs550_GetLastErrors</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:gab5c78c74113daef4f74aefbc57e92b3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga541b6125f67b83adfe5f508215d59ea6"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga541b6125f67b83adfe5f508215d59ea6">XUartNs550_GetModemStatus</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga541b6125f67b83adfe5f508215d59ea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b3eb97421a6a66e7029e9afafd8a74b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="struct_x_uart_ns550_format.html">XUartNs550Format</a> *FormatPtr)</td></tr>
<tr class="separator:ga4b3eb97421a6a66e7029e9afafd8a74b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7928b4629d2a36d5f771040176746f10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="struct_x_uart_ns550_format.html">XUartNs550Format</a> *FormatPtr)</td></tr>
<tr class="separator:ga7928b4629d2a36d5f771040176746f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadf7c4826f92d5e8fd70763f4448a360d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gadf7c4826f92d5e8fd70763f4448a360d">XUartNs550_SetHandler</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="group__uartns550__v3__3.html#ga21a8c40dd3f55a6a052d91bfe2ad8228">XUartNs550_Handler</a> FuncPtr, void *CallBackRef)</td></tr>
<tr class="separator:gadf7c4826f92d5e8fd70763f4448a360d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e8579fcf317e1f30d61b4fb7fe60434"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga6e8579fcf317e1f30d61b4fb7fe60434">XUartNs550_InterruptHandler</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga6e8579fcf317e1f30d61b4fb7fe60434"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad859e54c9baab85a7dd46b6851384ff6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gad859e54c9baab85a7dd46b6851384ff6">XUartNs550_GetStats</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr, <a class="el" href="struct_x_uart_ns550_stats.html">XUartNs550Stats</a> *StatsPtr)</td></tr>
<tr class="separator:gad859e54c9baab85a7dd46b6851384ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga67e2cea916214f246e449b8438d01384"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga67e2cea916214f246e449b8438d01384">XUartNs550_ClearStats</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga67e2cea916214f246e449b8438d01384"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ec86252a3b83b8d7b4815ffb960562d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest</a> (<a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *InstancePtr)</td></tr>
<tr class="separator:ga2ec86252a3b83b8d7b4815ffb960562d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga08856530b609941a65bb86a2ea1e5f5c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga08856530b609941a65bb86a2ea1e5f5c">XUartNs550_SendByte</a> (u32 BaseAddress, u8 Data)</td></tr>
<tr class="separator:ga08856530b609941a65bb86a2ea1e5f5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f46178664ca6c18e631b64d0dde6e25"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga7f46178664ca6c18e631b64d0dde6e25">XUartNs550_RecvByte</a> (u32 BaseAddress)</td></tr>
<tr class="separator:ga7f46178664ca6c18e631b64d0dde6e25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaec2dc3c8efd837825dc6c338e2397cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gaaec2dc3c8efd837825dc6c338e2397cc">XUartNs550_SetBaud</a> (u32 BaseAddress, u32 InputClockHz, u32 BaudRate)</td></tr>
<tr class="separator:gaaec2dc3c8efd837825dc6c338e2397cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga5cd4c8bf2383f952ef18132b828636fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga5cd4c8bf2383f952ef18132b828636fc">XUartNs550_ConfigTable</a> []</td></tr>
<tr class="separator:ga5cd4c8bf2383f952ef18132b828636fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5cd4c8bf2383f952ef18132b828636fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga5cd4c8bf2383f952ef18132b828636fc">XUartNs550_ConfigTable</a> []</td></tr>
<tr class="separator:ga5cd4c8bf2383f952ef18132b828636fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Configuration options</h2></td></tr>
<tr class="memitem:ga08a745fcffbdb351b5bac16197578eba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga08a745fcffbdb351b5bac16197578eba">XUN_OPTION_RXLINE_INTR</a>&#160;&#160;&#160;0x0800</td></tr>
<tr class="separator:ga08a745fcffbdb351b5bac16197578eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Data format values</h2></td></tr>
<tr class="memitem:ga7d074166a6d63f05a7f5b4d8600eef81"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga7d074166a6d63f05a7f5b4d8600eef81">XUN_FORMAT_8_BITS</a>&#160;&#160;&#160;3</td></tr>
<tr class="separator:ga7d074166a6d63f05a7f5b4d8600eef81"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Modem status values</h2></td></tr>
<tr class="memitem:gab901a667c0092c479c5d9010ed7502d2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gab901a667c0092c479c5d9010ed7502d2">XUN_MODEM_DCD_DELTA_MASK</a>&#160;&#160;&#160;0x08</td></tr>
<tr class="separator:gab901a667c0092c479c5d9010ed7502d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Callback events</h2></td></tr>
<tr class="memitem:gabc9845fc2ec5078c1beea2b1e1f8458c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#gabc9845fc2ec5078c1beea2b1e1f8458c">XUN_EVENT_RECV_DATA</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:gabc9845fc2ec5078c1beea2b1e1f8458c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Error values</h2></td></tr>
<tr class="memitem:ga30f8d32289eefb7b8f4144e702da0248"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__uartns550__v3__3.html#ga30f8d32289eefb7b8f4144e702da0248">XUN_ERROR_BREAK_MASK</a>&#160;&#160;&#160;0x10</td></tr>
<tr class="separator:ga30f8d32289eefb7b8f4144e702da0248"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga9039b3a4a9852fa556e522976edd1288"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_DisableIntr</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>((BaseAddress), <a class="code" href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a>,              \</div>
<div class="line">                        <a class="code" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>((BaseAddress), <a class="code" href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a>) &amp; \</div>
<div class="line">                        ~(<a class="code" href="group__uartns550__v3__3.html#gaf385b4925367d2717920845f2880ba47">XUN_IER_RX_LINE</a> | <a class="code" href="group__uartns550__v3__3.html#ga8536fc383eb2b08497a576b186547930">XUN_IER_TX_EMPTY</a> | <a class="code" href="group__uartns550__v3__3.html#gae3baa08e218c2f904b1f28ffd06bc527">XUN_IER_RX_DATA</a>))</div>
<div class="ttc" id="group__uartns550__v3__3_html_ga8536fc383eb2b08497a576b186547930"><div class="ttname"><a href="group__uartns550__v3__3.html#ga8536fc383eb2b08497a576b186547930">XUN_IER_TX_EMPTY</a></div><div class="ttdeci">#define XUN_IER_TX_EMPTY</div><div class="ttdoc">Transmitter empty interrupt. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:111</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_gaf385b4925367d2717920845f2880ba47"><div class="ttname"><a href="group__uartns550__v3__3.html#gaf385b4925367d2717920845f2880ba47">XUN_IER_RX_LINE</a></div><div class="ttdeci">#define XUN_IER_RX_LINE</div><div class="ttdoc">Receive status interrupt. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:110</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_ga58ff500307c70fda263888b18fc6389c"><div class="ttname"><a href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a></div><div class="ttdeci">#define XUartNs550_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">Read a UART register. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:201</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_gae3baa08e218c2f904b1f28ffd06bc527"><div class="ttname"><a href="group__uartns550__v3__3.html#gae3baa08e218c2f904b1f28ffd06bc527">XUN_IER_RX_DATA</a></div><div class="ttdeci">#define XUN_IER_RX_DATA</div><div class="ttdoc">Receiver data available. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:112</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_ga270ca9810a3fde617c7fd9f5bc707e6d"><div class="ttname"><a href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a></div><div class="ttdeci">#define XUN_IER_OFFSET</div><div class="ttdoc">Interrupt enable. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:86</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_gae648146666080fdac4f6949b6ed3101a"><div class="ttname"><a href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a></div><div class="ttdeci">#define XUartNs550_WriteReg(BaseAddress, RegOffset, RegisterValue)</div><div class="ttdoc">Write to a UART register. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:220</div></div>
</div><!-- fragment -->
<p>Disable the transmit and receive interrupts of the UART. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: void <a class="el" href="group__uartns550__v3__3.html#ga9039b3a4a9852fa556e522976edd1288" title="Disable the transmit and receive interrupts of the UART. ">XUartNs550_DisableIntr(u32 BaseAddress)</a>;, </dd></dl>

</div>
</div>
<a class="anchor" id="ga24622c1399f2cbab46e9dda140ef4aa0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_EnableIntr</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>((BaseAddress), <a class="code" href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a>,              \</div>
<div class="line">                         <a class="code" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>((BaseAddress), <a class="code" href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a>) | \</div>
<div class="line">                         (<a class="code" href="group__uartns550__v3__3.html#gaf385b4925367d2717920845f2880ba47">XUN_IER_RX_LINE</a> | <a class="code" href="group__uartns550__v3__3.html#ga8536fc383eb2b08497a576b186547930">XUN_IER_TX_EMPTY</a> | <a class="code" href="group__uartns550__v3__3.html#gae3baa08e218c2f904b1f28ffd06bc527">XUN_IER_RX_DATA</a>))</div>
<div class="ttc" id="group__uartns550__v3__3_html_ga8536fc383eb2b08497a576b186547930"><div class="ttname"><a href="group__uartns550__v3__3.html#ga8536fc383eb2b08497a576b186547930">XUN_IER_TX_EMPTY</a></div><div class="ttdeci">#define XUN_IER_TX_EMPTY</div><div class="ttdoc">Transmitter empty interrupt. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:111</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_gaf385b4925367d2717920845f2880ba47"><div class="ttname"><a href="group__uartns550__v3__3.html#gaf385b4925367d2717920845f2880ba47">XUN_IER_RX_LINE</a></div><div class="ttdeci">#define XUN_IER_RX_LINE</div><div class="ttdoc">Receive status interrupt. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:110</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_ga58ff500307c70fda263888b18fc6389c"><div class="ttname"><a href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a></div><div class="ttdeci">#define XUartNs550_ReadReg(BaseAddress, RegOffset)</div><div class="ttdoc">Read a UART register. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:201</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_gae3baa08e218c2f904b1f28ffd06bc527"><div class="ttname"><a href="group__uartns550__v3__3.html#gae3baa08e218c2f904b1f28ffd06bc527">XUN_IER_RX_DATA</a></div><div class="ttdeci">#define XUN_IER_RX_DATA</div><div class="ttdoc">Receiver data available. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:112</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_ga270ca9810a3fde617c7fd9f5bc707e6d"><div class="ttname"><a href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a></div><div class="ttdeci">#define XUN_IER_OFFSET</div><div class="ttdoc">Interrupt enable. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:86</div></div>
<div class="ttc" id="group__uartns550__v3__3_html_gae648146666080fdac4f6949b6ed3101a"><div class="ttname"><a href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a></div><div class="ttdeci">#define XUartNs550_WriteReg(BaseAddress, RegOffset, RegisterValue)</div><div class="ttdoc">Write to a UART register. </div><div class="ttdef"><b>Definition:</b> xuartns550_l.h:220</div></div>
</div><!-- fragment -->
<p>Enable the transmit and receive interrupts of the UART. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: void <a class="el" href="group__uartns550__v3__3.html#ga24622c1399f2cbab46e9dda140ef4aa0" title="Enable the transmit and receive interrupts of the UART. ">XUartNs550_EnableIntr(u32 BaseAddress)</a>;, </dd></dl>

</div>
</div>
<a class="anchor" id="gab9ba96c18cb50a8ab5873d781b4ee94e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_GetLineControlReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>((BaseAddress), <a class="el" href="group__uartns550__v3__3.html#ga50bcaf32aedaf4476931b898961a533f">XUN_LCR_OFFSET</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Get the UART Line Status Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value read from the register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: u32 <a class="el" href="group__uartns550__v3__3.html#gab9ba96c18cb50a8ab5873d781b4ee94e" title="Get the UART Line Status Register. ">XUartNs550_GetLineControlReg(u32 BaseAddress)</a>; </dd></dl>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, <a class="el" href="group__uartns550__v3__3.html#gaaec2dc3c8efd837825dc6c338e2397cc">XUartNs550_SetBaud()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5bbc90c39e15adea04c63548dd537cc5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_GetLineStatusReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>((BaseAddress), <a class="el" href="group__uartns550__v3__3.html#ga9cb658f2d8ea9eb438ee626a74ab65ef">XUN_LSR_OFFSET</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Get the UART Line Status Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value read from the register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: u32 <a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5" title="Get the UART Line Status Register. ">XUartNs550_GetLineStatusReg(u32 BaseAddress)</a>; </dd></dl>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaab822fbaed4a57714779e35b6be6f090">XUartNs550_IsSending()</a>, <a class="el" href="group__uartns550__v3__3.html#ga6df754edf91aea638537a15536d4d34e">XUartNs550_ReceiveBuffer()</a>, <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="ga941188ffba023576548effef6ccb0707"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_IsReceiveData</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress</td><td>)</td>
          <td>&#160;&#160;&#160;(<a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>(BaseAddress) &amp; <a class="el" href="group__uartns550__v3__3.html#ga64e43cf523785c523618adc1f046370f">XUN_LSR_DATA_READY</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Determine if there is receive data in the receiver and/or FIFO. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if there is receive data, FALSE otherwise.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: int <a class="el" href="group__uartns550__v3__3.html#ga941188ffba023576548effef6ccb0707" title="Determine if there is receive data in the receiver and/or FIFO. ">XUartNs550_IsReceiveData(u32 BaseAddress)</a>;, </dd></dl>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7f46178664ca6c18e631b64d0dde6e25">XUartNs550_RecvByte()</a>.</p>

</div>
</div>
<a class="anchor" id="gabae5b671e19c043af9e1c76e183acb60"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_IsTransmitEmpty</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress</td><td>)</td>
          <td>&#160;&#160;&#160;(<a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>(BaseAddress) &amp; <a class="el" href="group__uartns550__v3__3.html#gacfc60ddcada499862b482041805b1f03">XUN_LSR_TX_BUFFER_EMPTY</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Determine if a byte of data can be sent with the transmitter. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if a byte can be sent, FALSE otherwise.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: int <a class="el" href="group__uartns550__v3__3.html#gabae5b671e19c043af9e1c76e183acb60" title="Determine if a byte of data can be sent with the transmitter. ">XUartNs550_IsTransmitEmpty(u32 BaseAddress)</a>;, </dd></dl>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga08856530b609941a65bb86a2ea1e5f5c">XUartNs550_SendByte()</a>.</p>

</div>
</div>
<a class="anchor" id="ga58ff500307c70fda263888b18fc6389c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_ReadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;Xil_In32((BaseAddress) + (RegOffset))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Read a UART register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>contains the offset from the 1st register of the device to select the specific register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value read from the register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: u32 <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c" title="Read a UART register. ">XUartNs550_ReadReg(u32 BaseAddress, u32 RegOffset)</a>; </dd></dl>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga541b6125f67b83adfe5f508215d59ea6">XUartNs550_GetModemStatus()</a>, <a class="el" href="group__uartns550__v3__3.html#ga120797e7b4fc719c827c4378e387efe4">XUartNs550_GetOptions()</a>, <a class="el" href="group__uartns550__v3__3.html#ga6e8579fcf317e1f30d61b4fb7fe60434">XUartNs550_InterruptHandler()</a>, <a class="el" href="group__uartns550__v3__3.html#ga6df754edf91aea638537a15536d4d34e">XUartNs550_ReceiveBuffer()</a>, <a class="el" href="group__uartns550__v3__3.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv()</a>, <a class="el" href="group__uartns550__v3__3.html#ga7f46178664ca6c18e631b64d0dde6e25">XUartNs550_RecvByte()</a>, <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>, <a class="el" href="group__uartns550__v3__3.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send()</a>, <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>, and <a class="el" href="group__uartns550__v3__3.html#gac2270082fbb7d7b2c32bd9208dae5be3">XUartNs550_SetOptions()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4f3ff99ca70dfe6c715cbbfdd9742230"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_SetLineControlReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegisterValue&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>((BaseAddress), <a class="el" href="group__uartns550__v3__3.html#ga50bcaf32aedaf4476931b898961a533f">XUN_LCR_OFFSET</a>, (RegisterValue))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Set the UART Line Status Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device. </td></tr>
    <tr><td class="paramname">RegisterValue</td><td>is the value to be written to the register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: void XUartNs550_SetLineControlReg(u32 BaseAddress, u32 RegisterValue); </dd></dl>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize()</a>, <a class="el" href="group__uartns550__v3__3.html#gaaec2dc3c8efd837825dc6c338e2397cc">XUartNs550_SetBaud()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="gae648146666080fdac4f6949b6ed3101a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUartNs550_WriteReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegisterValue&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;Xil_Out32((BaseAddress) + (RegOffset), (RegisterValue))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Write to a UART register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the device. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>contains the offset from the 1st register of the device to select the specific register. </td></tr>
    <tr><td class="paramname">RegisterValue</td><td>is the value to be written to the regsiter.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-Style signature: u32 XUartNs550_WriteReg(u32 BaseAddress, u32 RegOffset, u32 RegisterValue); </dd></dl>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize()</a>, <a class="el" href="group__uartns550__v3__3.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv()</a>, <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>, <a class="el" href="group__uartns550__v3__3.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send()</a>, <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>, <a class="el" href="group__uartns550__v3__3.html#ga08856530b609941a65bb86a2ea1e5f5c">XUartNs550_SendByte()</a>, <a class="el" href="group__uartns550__v3__3.html#gaaec2dc3c8efd837825dc6c338e2397cc">XUartNs550_SetBaud()</a>, <a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold()</a>, and <a class="el" href="group__uartns550__v3__3.html#gac2270082fbb7d7b2c32bd9208dae5be3">XUartNs550_SetOptions()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9923a9e780653084f76cd38f4008d0c5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_DRLM_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x04)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Divisor Register MSB. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaaec2dc3c8efd837825dc6c338e2397cc">XUartNs550_SetBaud()</a>.</p>

</div>
</div>
<a class="anchor" id="gad024e52bf451be70a16217ee15136558"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_DRLS_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x00)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Divisor Register LSB. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaaec2dc3c8efd837825dc6c338e2397cc">XUartNs550_SetBaud()</a>.</p>

</div>
</div>
<a class="anchor" id="ga30f8d32289eefb7b8f4144e702da0248"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_ERROR_BREAK_MASK&#160;&#160;&#160;0x10</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>These constants specify the errors that may be retrieved from the driver using the XUartNs550_GetLastErrors function. </p>
<p>All of them are bit masks, except no error, such that multiple errors may be specified.Break detected </p>

</div>
</div>
<a class="anchor" id="ga34ea957b9587fc0a2571be9d0816e994"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_ERROR_FRAMING_MASK&#160;&#160;&#160;0x08</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Receive framing error. </p>

</div>
</div>
<a class="anchor" id="ga9f68b9cbaa34388aab27c289db3e390a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_ERROR_NONE&#160;&#160;&#160;0x00</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>No error. </p>

</div>
</div>
<a class="anchor" id="ga87c3d1d1c50213ac56e0c60f544761e2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_ERROR_OVERRUN_MASK&#160;&#160;&#160;0x02</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Receive overrun error. </p>

</div>
</div>
<a class="anchor" id="gaaeba54cf3dd6a4113dbcea2c02acdfcf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_ERROR_PARITY_MASK&#160;&#160;&#160;0x04</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Receive parity error. </p>

</div>
</div>
<a class="anchor" id="gae10be1699ad350ccd9290a85e9d07832"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_EVENT_MODEM&#160;&#160;&#160;5</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>A change in modem status. </p>

</div>
</div>
<a class="anchor" id="gabc9845fc2ec5078c1beea2b1e1f8458c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_EVENT_RECV_DATA&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>These constants specify the handler events that are passed to a handler from the driver. </p>
<p>These constants are not bit masks such that only one will be passed at a time to the handler.Data has been received </p>

</div>
</div>
<a class="anchor" id="ga658d137ce80d2dba58593fdc9266eded"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_EVENT_RECV_ERROR&#160;&#160;&#160;4</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>A receive error was detected. </p>

</div>
</div>
<a class="anchor" id="gadcf08384f79c532d7476ef470eeef32a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_EVENT_RECV_TIMEOUT&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>A receive timeout occurred. </p>

</div>
</div>
<a class="anchor" id="ga935c9a27e790c469337b884f42db9266"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_EVENT_SENT_DATA&#160;&#160;&#160;3</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Data has been sent. </p>

</div>
</div>
<a class="anchor" id="ga3d652c8c88fd310239eab927dff43d94"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FCR_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x08)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Fifo control, write only. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize()</a>, <a class="el" href="group__uartns550__v3__3.html#ga120797e7b4fc719c827c4378e387efe4">XUartNs550_GetOptions()</a>, <a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold()</a>, and <a class="el" href="group__uartns550__v3__3.html#gac2270082fbb7d7b2c32bd9208dae5be3">XUartNs550_SetOptions()</a>.</p>

</div>
</div>
<a class="anchor" id="ga729d149d84afe79ed69445f8bf6d5101"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_ENABLE&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Enable the FIFOs. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize()</a>, and <a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold()</a>.</p>

</div>
</div>
<a class="anchor" id="gac547846d9841b9801f6b6cd2c879e881"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_RX_RESET&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Reset the receive FIFO. </p>

</div>
</div>
<a class="anchor" id="ga5b79e08613c8560b6f959a7e99de2914"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_RX_TRIG_LSB&#160;&#160;&#160;0x00000040</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Trigger level LSB. </p>

</div>
</div>
<a class="anchor" id="ga4b16c45a8ec1b6fe90e862d4db5f5558"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_RX_TRIG_MSB&#160;&#160;&#160;0x00000080</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Trigger level MSB. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="gab75853d561b5a47735a412acc54b1507"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_RX_TRIGGER&#160;&#160;&#160;0x000000C0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Both trigger level bits. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga4f7c185a91f28f3490fa8ef71dab1059">XUartNs550_GetFifoThreshold()</a>, and <a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold()</a>.</p>

</div>
</div>
<a class="anchor" id="ga53fffaa233387f3bdc9f8524f4c0498f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_TRIGGER_01&#160;&#160;&#160;0x00</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>1 byte trigger level </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold()</a>.</p>

</div>
</div>
<a class="anchor" id="ga098110c073d9bb2840174ec3bfd2d974"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_TRIGGER_04&#160;&#160;&#160;0x40</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>4 byte trigger level </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold()</a>.</p>

</div>
</div>
<a class="anchor" id="gab3a4c3dc39b03ebc237b78d99980ee53"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_TRIGGER_08&#160;&#160;&#160;0x80</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>8 byte trigger level </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa456eb0224a4c1d84177c39e3514d446"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_TRIGGER_14&#160;&#160;&#160;0xC0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>14 byte trigger level </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaedd1056b9f1283ee15c1a3c349acb845">XUartNs550_SetFifoThreshold()</a>.</p>

</div>
</div>
<a class="anchor" id="gad43092374d907d369cfa0c09bccf39c2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FIFO_TX_RESET&#160;&#160;&#160;0x00000004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Reset the transmit FIFO. </p>

</div>
</div>
<a class="anchor" id="gadde11ab1bed0554bf6863a425a9b6883"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_1_STOP_BIT&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>1 stop bit </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga87a29bbab99baca04a1b2f860000f45d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_2_STOP_BIT&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>2 stop bits </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5ab6a6a6c4ba6f74203012cb83a2d7f8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_5_BITS&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>5 data bits </p>

</div>
</div>
<a class="anchor" id="ga88d0995c5946998d12141d57a1f42a11"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_6_BITS&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>6 data bits </p>

</div>
</div>
<a class="anchor" id="ga42ab3cfade8f43ee12f04f111c336ddc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_7_BITS&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>7 data bits </p>

</div>
</div>
<a class="anchor" id="ga7d074166a6d63f05a7f5b4d8600eef81"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_8_BITS&#160;&#160;&#160;3</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>These constants specify the data format that may be set or retrieved with the driver. </p>
<p>The data format includes the number of data bits, the number of stop bits and parity.8 data bits </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3ceb996b058ef788676793d1da22b4fd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_EVEN_PARITY&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Even Parity. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga12c4007e0384a40140cff2ccd42d20d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_NO_PARITY&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>No Parity. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="gae820f584c1473ec1fcb8dcab5ff53752"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_FORMAT_ODD_PARITY&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Odd Parity. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga283d7f5d44a578ce4ae7f3667ba36908"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_IER_MODEM_STATUS&#160;&#160;&#160;0x00000008</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Modem status interrupt. </p>

</div>
</div>
<a class="anchor" id="ga270ca9810a3fde617c7fd9f5bc707e6d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_IER_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x04)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Interrupt enable. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv()</a>, <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>, <a class="el" href="group__uartns550__v3__3.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="gae3baa08e218c2f904b1f28ffd06bc527"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_IER_RX_DATA&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Receiver data available. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf385b4925367d2717920845f2880ba47"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_IER_RX_LINE&#160;&#160;&#160;0x00000004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Receive status interrupt. </p>

</div>
</div>
<a class="anchor" id="ga8536fc383eb2b08497a576b186547930"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_IER_TX_EMPTY&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Transmitter empty interrupt. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="ga36427b607774c1107afd847eb85bc4c9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_IIR_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x08)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Interrupt id, read only. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga6e8579fcf317e1f30d61b4fb7fe60434">XUartNs550_InterruptHandler()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="gad37ac1583a8e7e9f34530947b89e06fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_INT_ID_FIFOS_ENABLED&#160;&#160;&#160;0x000000C0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Only the FIFOs enable. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="ga1770fc9ccf8e1fb1549e53fb83bf2980"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_INT_ID_MASK&#160;&#160;&#160;0x0000000F</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Only the interrupt ID. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga6e8579fcf317e1f30d61b4fb7fe60434">XUartNs550_InterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gac7f9d8d22514af63f22691f8b0aaee5c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_2_STOP_BITS&#160;&#160;&#160;0x00000004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>1= 2 stop bits,0 = 1 stop bit </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="gac4a2b734e8f1aa8c0935ee3afa8f6a00"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_6_DATA_BITS&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>6 Data bits selection </p>

</div>
</div>
<a class="anchor" id="gaf6444c0fe2141a04caa36c3ceff7e7bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_7_DATA_BITS&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>7 Data bits selection </p>

</div>
</div>
<a class="anchor" id="gab8237823909f5df4df1635ffe6c3fd8e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_8_DATA_BITS&#160;&#160;&#160;0x00000003</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>8 Data bits selection </p>

</div>
</div>
<a class="anchor" id="gaa2aa323315e8d4e0265bcb004debc302"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_DLAB&#160;&#160;&#160;0x00000080</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Divisor latch access. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaaec2dc3c8efd837825dc6c338e2397cc">XUartNs550_SetBaud()</a>.</p>

</div>
</div>
<a class="anchor" id="ga4a5273b5f25d43f994d23adcfaceb06f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_ENABLE_PARITY&#160;&#160;&#160;0x00000008</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>1 = Enable, 0 = Disable parity </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5a9981c3534734f46ae6a7761c272cd2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_EVEN_PARITY&#160;&#160;&#160;0x00000010</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>1 = even, 0 = odd parity </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga483bdd6c37b57123fdc2a3da8a74a39f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_LENGTH_MASK&#160;&#160;&#160;0x00000003</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Both length bits mask. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga7928b4629d2a36d5f771040176746f10">XUartNs550_GetDataFormat()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga50bcaf32aedaf4476931b898961a533f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x0C)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Line Control Register. </p>

</div>
</div>
<a class="anchor" id="gaa87780e1deb82b5068dc0d4f2c495098"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_PARITY_MASK&#160;&#160;&#160;0x00000018</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Both parity bits mask. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga4b3eb97421a6a66e7029e9afafd8a74b">XUartNs550_SetDataFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="gac488c0877e5d9195ba6702c5d87bbac1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_SET_BREAK&#160;&#160;&#160;0x00000040</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Cause a break condition. </p>

</div>
</div>
<a class="anchor" id="gadb09446c6f42dc66f5247562cb467b83"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LCR_STICK_PARITY&#160;&#160;&#160;0x00000020</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Stick Parity. </p>

</div>
</div>
<a class="anchor" id="gae74ee94f0c84de4861c57c04bff0d390"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_BREAK_INT&#160;&#160;&#160;0x00000010</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Break detected interrupt. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga6df754edf91aea638537a15536d4d34e">XUartNs550_ReceiveBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="ga64e43cf523785c523618adc1f046370f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_DATA_READY&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Receive data ready. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga6df754edf91aea638537a15536d4d34e">XUartNs550_ReceiveBuffer()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf2d9f7f1bffd43b92ef31d187f4bcb5e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_ERROR_BREAK&#160;&#160;&#160;0x0000001E</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Errors except FIFO error and break detected. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gab5c78c74113daef4f74aefbc57e92b3a">XUartNs550_GetLastErrors()</a>.</p>

</div>
</div>
<a class="anchor" id="ga55e6bddf04ae12aba48d7176dbec9763"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_FRAMING_ERROR&#160;&#160;&#160;0x00000008</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Framing error on current byte. </p>

</div>
</div>
<a class="anchor" id="ga9cb658f2d8ea9eb438ee626a74ab65ef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x14)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Line Status Register. </p>

</div>
</div>
<a class="anchor" id="ga21276c29b98219b18cf86d0eb2c7134b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_OVERRUN_ERROR&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Overrun error on receive FIFO. </p>

</div>
</div>
<a class="anchor" id="ga94c55231673313abf9f38f451bf952b4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_PARITY_ERROR&#160;&#160;&#160;0x00000004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Parity error on current byte. </p>

</div>
</div>
<a class="anchor" id="gab923b7cea4222649e9cf8a0a7413ed35"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_RX_FIFO_ERROR&#160;&#160;&#160;0x00000080</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>An errored byte is in FIFO. </p>

</div>
</div>
<a class="anchor" id="gacfc60ddcada499862b482041805b1f03"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_TX_BUFFER_EMPTY&#160;&#160;&#160;0x00000020</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Transmit holding reg empty. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="ga648b52ef84c2214179e2fe3c80d77677"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_LSR_TX_EMPTY&#160;&#160;&#160;0x00000040</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Transmitter is empty. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#gaab822fbaed4a57714779e35b6be6f090">XUartNs550_IsSending()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3c2e9f72e54de87dedaafe6085ae4ec9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MCR_DTR&#160;&#160;&#160;0x00000001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>DTR signal. </p>

</div>
</div>
<a class="anchor" id="ga04187396f216eb0cd5be0db172fb1934"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MCR_LOOP&#160;&#160;&#160;0x00000010</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Local loopback. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9046de189f3f0a647fc5c908324f31d9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MCR_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x10)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Modem Control Register. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga73b885722152824dc9a12d643dea0bf5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MCR_OUT_1&#160;&#160;&#160;0x00000004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>General output 1 signal. </p>

</div>
</div>
<a class="anchor" id="gaeb40f8130a80ee807ea023a371bf8c38"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MCR_OUT_2&#160;&#160;&#160;0x00000008</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>General output 2 signal. </p>

</div>
</div>
<a class="anchor" id="gae4f30ef843108b79b9d582bada19819a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MCR_RTS&#160;&#160;&#160;0x00000002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>RTS signal. </p>

</div>
</div>
<a class="anchor" id="gae5813f86719707f5c77073752c691eec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MODEM_CTS_DELTA_MASK&#160;&#160;&#160;0x01</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>CTS signal changed state. </p>

</div>
</div>
<a class="anchor" id="gabc81d97fc18bf0eb131fb8072c3cfc0e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MODEM_CTS_MASK&#160;&#160;&#160;0x10</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Current state of CTS signal. </p>

</div>
</div>
<a class="anchor" id="gab901a667c0092c479c5d9010ed7502d2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MODEM_DCD_DELTA_MASK&#160;&#160;&#160;0x08</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>These constants specify the modem status that may be retrieved from the driver. </p>
<p>DCD signal changed state </p>

</div>
</div>
<a class="anchor" id="ga8e16fdbc7a9cfe0a278223cae7ea337a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MODEM_DCD_MASK&#160;&#160;&#160;0x80</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Current state of DCD signal. </p>

</div>
</div>
<a class="anchor" id="ga82340069f99a118706aba7e7fb151dd4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MODEM_DSR_DELTA_MASK&#160;&#160;&#160;0x02</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>DSR signal changed state. </p>

</div>
</div>
<a class="anchor" id="ga1aeb58a464b66388317130cd8494d270"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MODEM_DSR_MASK&#160;&#160;&#160;0x20</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Current state of DSR signal. </p>

</div>
</div>
<a class="anchor" id="gacf0b84214ccac5dc53ad63bfee0b2af1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MODEM_RING_STOP_MASK&#160;&#160;&#160;0x04</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Ringing has stopped. </p>

</div>
</div>
<a class="anchor" id="ga04af798da0a7441edba3f2422311b407"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MODEM_RINGING_MASK&#160;&#160;&#160;0x40</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Ring signal is active. </p>

</div>
</div>
<a class="anchor" id="ga69e96899321d1c793301e52cb4ff7d5b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_MSR_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET + 0x18)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Modem Status Register. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga541b6125f67b83adfe5f508215d59ea6">XUartNs550_GetModemStatus()</a>.</p>

</div>
</div>
<a class="anchor" id="ga98413720ccbd9c0e7a47468885d894a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_ASSERT_DTR&#160;&#160;&#160;0x0001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Assert DTR signal. </p>

</div>
</div>
<a class="anchor" id="gadfd56895540a03acdc510be3df5d2af2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_ASSERT_OUT1&#160;&#160;&#160;0x0004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Assert out1 signal. </p>

</div>
</div>
<a class="anchor" id="ga98ca88cd5c9a0dbbb44ab7feee22e1ea"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_ASSERT_OUT2&#160;&#160;&#160;0x0008</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Assert out2 signal. </p>

</div>
</div>
<a class="anchor" id="ga0b4be9e79ab42ff65c9ccbccfd53d1e8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_ASSERT_RTS&#160;&#160;&#160;0x0002</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Assert RTS signal. </p>

</div>
</div>
<a class="anchor" id="ga616329329f125e69b957d98d23c0c80d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_DATA_INTR&#160;&#160;&#160;0x0100</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Enable data interrupts. </p>

</div>
</div>
<a class="anchor" id="ga9bd45da1706d1d6cfc0f22d4fca46100"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_FIFOS_ENABLE&#160;&#160;&#160;0x0040</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Enable FIFOs. </p>

</div>
</div>
<a class="anchor" id="gaaf47eddf3f91b4dfea5fa70849ccf094"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_LOOPBACK&#160;&#160;&#160;0x0200</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Enable local loopback. </p>

</div>
</div>
<a class="anchor" id="gadcf53248ec112623a28737a2e584683d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_MODEM_INTR&#160;&#160;&#160;0x0080</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Enable modem interrupts. </p>

</div>
</div>
<a class="anchor" id="ga7aa1ecea52619ad2676a6d4ac3beb759"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_RESET_RX_FIFO&#160;&#160;&#160;0x0010</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Reset the receive FIFO. </p>

</div>
</div>
<a class="anchor" id="ga1cbbc5bddc953994ea0cb2366e3e5d60"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_RESET_TX_FIFO&#160;&#160;&#160;0x0020</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Reset the transmit FIFO. </p>

</div>
</div>
<a class="anchor" id="ga08a745fcffbdb351b5bac16197578eba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_RXLINE_INTR&#160;&#160;&#160;0x0800</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>These constants specify the options that may be set or retrieved with the driver, each is a unique bit mask such that multiple options may be specified. </p>
<p>These constants indicate the function of the option when in the active state.Enable status interrupt </p>

</div>
</div>
<a class="anchor" id="ga2b69543bcd3d4e794193b9b47da1bcce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_OPTION_SET_BREAK&#160;&#160;&#160;0x0400</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Set a break condition. </p>

</div>
</div>
<a class="anchor" id="ga0c9f6a9aff7a8753caf9965f3162c2ce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_RBR_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Receive buffer, read only. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga6df754edf91aea638537a15536d4d34e">XUartNs550_ReceiveBuffer()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga7f46178664ca6c18e631b64d0dde6e25">XUartNs550_RecvByte()</a>.</p>

</div>
</div>
<a class="anchor" id="gaaeadf9e35937495ade3ac065a4a6ccbf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XUN_THR_OFFSET&#160;&#160;&#160;(XUN_REG_OFFSET)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8h.html">xuartns550_l.h</a>&gt;</code></p>

<p>Transmit holding register. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga08856530b609941a65bb86a2ea1e5f5c">XUartNs550_SendByte()</a>.</p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga21a8c40dd3f55a6a052d91bfe2ad8228"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XUartNs550_Handler) (void *CallBackRef, u32 Event, unsigned int EventData)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This data type defines a handler which the application must define when using interrupt mode. </p>
<p>The handler will be called from the driver in an interrupt context to handle application specific processing.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is a callback reference passed in by the upper layer when setting the handler, and is passed back to the upper layer when the handler is called. </td></tr>
    <tr><td class="paramname">Event</td><td>contains one of the event constants indicating why the handler is being called. </td></tr>
    <tr><td class="paramname">EventData</td><td>contains the number of bytes sent or received at the time of the call for send and receive events and contains the modem status for modem events. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga37a67d6e3901ba6bee3df7c51dab093b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XUartNs550_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a> *&#160;</td>
          <td class="paramname"><em>Config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8c.html">xuartns550.c</a>&gt;</code></p>

<p>Initializes a specific <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance such that it is ready to be used. </p>
<p>The data format of the device is setup for 8 data bits, 1 stop bit, and no parity by default. The baud rate is set to a default value specified by Config-&gt;DefaultBaudRate if set, otherwise it is set to 19.2K baud. If the device has FIFOs (16550), they are enabled and the a receive FIFO threshold is set for 8 bytes. The default operating mode of the driver is polled mode.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. </td></tr>
    <tr><td class="paramname">Config</td><td>is a reference to a structure containing information about a specific UART 16450/16550 device. XUartNs550_Init initializes an InstancePtr object for a specific device specified by the contents f Config. XUartNs550_Init can initialize multiple instance objects with the use of multiple calls giving different Config information on each call. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the device base address in the virtual memory address space. The caller is responsible for keeping the address mapping from EffectiveAddr to the device physical base address unchanged once this function is invoked. Unexpected errors may occur if the address mapping changes after this function is called. If address translation is not used, use Config-&gt;BaseAddress for this parameters, passing the physical address instead.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li>
<li>XST_UART_BAUD_ERROR if the baud rate is not possible because the input clock frequency is not divisible with an acceptable amount of error.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550___config.html#a4f81c402732b39e1380edbdc8dc42b98">XUartNs550_Config::DefaultBaudRate</a>, <a class="el" href="struct_x_uart_ns550.html#a9cef284a40cb119ea1528b008f542862">XUartNs550::Handler</a>, <a class="el" href="struct_x_uart_ns550___config.html#a2ed94077fa9f598a8b86874e7d108831">XUartNs550_Config::InputClockHz</a>, <a class="el" href="struct_x_uart_ns550.html#a5a30613f3bceb3b6c4c969e7b711c36a">XUartNs550::InputClockHz</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="struct_x_uart_ns550.html#ab54b7f86adf3dc90af130717e7abe1da">XUartNs550::ReceiveBuffer</a>, <a class="el" href="struct_x_uart_ns550.html#a6e94aedae6660c25485e826e8488f081">XUartNs550::SendBuffer</a>, <a class="el" href="group__uartns550__v3__3.html#ga67e2cea916214f246e449b8438d01384">XUartNs550_ClearStats()</a>, <a class="el" href="group__uartns550__v3__3.html#ga4f3ff99ca70dfe6c715cbbfdd9742230">XUartNs550_SetLineControlReg</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga3d652c8c88fd310239eab927dff43d94">XUN_FCR_OFFSET</a>, <a class="el" href="group__uartns550__v3__3.html#ga729d149d84afe79ed69445f8bf6d5101">XUN_FIFO_ENABLE</a>, <a class="el" href="group__uartns550__v3__3.html#ga4b16c45a8ec1b6fe90e862d4db5f5558">XUN_FIFO_RX_TRIG_MSB</a>, and <a class="el" href="group__uartns550__v3__3.html#ga7d074166a6d63f05a7f5b4d8600eef81">XUN_FORMAT_8_BITS</a>.</p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga97009bf7b2508c14225b0d5835c256d0">XUartNs550_Initialize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga67e2cea916214f246e449b8438d01384"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XUartNs550_ClearStats </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This function zeros the statistics for the given instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550_stats.html#a0ff150c925459d98e4555193e980fbcb">XUartNs550Stats::CharactersReceived</a>, <a class="el" href="struct_x_uart_ns550_stats.html#abd414f52ad160c32832bc17a5451bfef">XUartNs550Stats::CharactersTransmitted</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="struct_x_uart_ns550_stats.html#aa65ee74968a73e8c7b8b218faf5d3530">XUartNs550Stats::ModemInterrupts</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a7346d4d8eba130d8c47c64711edadf98">XUartNs550Stats::ReceiveBreakDetected</a>, <a class="el" href="struct_x_uart_ns550_stats.html#ac33dce22ad55ac46c6ac7abe16500846">XUartNs550Stats::ReceiveFramingErrors</a>, <a class="el" href="struct_x_uart_ns550_stats.html#ab2e33346a9d877573006f4290958922f">XUartNs550Stats::ReceiveInterrupts</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a48bef70419479251de1523a4411615ed">XUartNs550Stats::ReceiveOverrunErrors</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a65f9e1e7119386a2cc91aecd2793474f">XUartNs550Stats::ReceiveParityErrors</a>, <a class="el" href="struct_x_uart_ns550.html#afa9d8ab9f317702502fdc31e6272535a">XUartNs550::Stats</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a9acf15361c4758bf0e0f6f2b8b8e9144">XUartNs550Stats::StatusInterrupts</a>, and <a class="el" href="struct_x_uart_ns550_stats.html#afeb7865c20a883942eb6e5d749c079eb">XUartNs550Stats::TransmitInterrupts</a>.</p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7928b4629d2a36d5f771040176746f10"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XUartNs550_GetDataFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550_format.html">XUartNs550Format</a> *&#160;</td>
          <td class="paramname"><em>FormatPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Gets the data format for the specified UART. </p>
<p>The data format includes the baud rate, number of data bits, number of stop bits, and parity.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. </td></tr>
    <tr><td class="paramname">FormatPtr</td><td>is a pointer to a format structure that will contain the data format after this call completes.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550_format.html#a5e0a377a4464adc0e31fb6953e6db5ee">XUartNs550Format::BaudRate</a>, <a class="el" href="struct_x_uart_ns550.html#a483f1f7edada3366bac4dd02e19a5264">XUartNs550::BaudRate</a>, <a class="el" href="struct_x_uart_ns550_format.html#abd1271766499c4ba190318b99bf1a0f5">XUartNs550Format::DataBits</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="struct_x_uart_ns550_format.html#aa3e59ccae311a6e3eb376805c92ffde3">XUartNs550Format::Parity</a>, <a class="el" href="struct_x_uart_ns550_format.html#ad6039467add1a8ec200b25e45538c740">XUartNs550Format::StopBits</a>, <a class="el" href="group__uartns550__v3__3.html#gab9ba96c18cb50a8ab5873d781b4ee94e">XUartNs550_GetLineControlReg</a>, <a class="el" href="group__uartns550__v3__3.html#gadde11ab1bed0554bf6863a425a9b6883">XUN_FORMAT_1_STOP_BIT</a>, <a class="el" href="group__uartns550__v3__3.html#ga87a29bbab99baca04a1b2f860000f45d">XUN_FORMAT_2_STOP_BIT</a>, <a class="el" href="group__uartns550__v3__3.html#ga3ceb996b058ef788676793d1da22b4fd">XUN_FORMAT_EVEN_PARITY</a>, <a class="el" href="group__uartns550__v3__3.html#ga12c4007e0384a40140cff2ccd42d20d6">XUN_FORMAT_NO_PARITY</a>, <a class="el" href="group__uartns550__v3__3.html#gae820f584c1473ec1fcb8dcab5ff53752">XUN_FORMAT_ODD_PARITY</a>, <a class="el" href="group__uartns550__v3__3.html#gac7f9d8d22514af63f22691f8b0aaee5c">XUN_LCR_2_STOP_BITS</a>, <a class="el" href="group__uartns550__v3__3.html#ga4a5273b5f25d43f994d23adcfaceb06f">XUN_LCR_ENABLE_PARITY</a>, <a class="el" href="group__uartns550__v3__3.html#ga5a9981c3534734f46ae6a7761c272cd2">XUN_LCR_EVEN_PARITY</a>, and <a class="el" href="group__uartns550__v3__3.html#ga483bdd6c37b57123fdc2a3da8a74a39f">XUN_LCR_LENGTH_MASK</a>.</p>

</div>
</div>
<a class="anchor" id="ga4f7c185a91f28f3490fa8ef71dab1059"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XUartNs550_GetFifoThreshold </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This function gets the receive FIFO trigger level. </p>
<p>The receive trigger level indicates the number of bytes in the receive FIFO that cause a receive data event (interrupt) to be generated.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current receive FIFO trigger level. Constants which define each trigger level are contained in the file <a class="el" href="xuartns550_8h.html">xuartns550.h</a> and named XUN_FIFO_TRIGGER_*.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, and <a class="el" href="group__uartns550__v3__3.html#gab75853d561b5a47735a412acc54b1507">XUN_FIFO_RX_TRIGGER</a>.</p>

</div>
</div>
<a class="anchor" id="gab5c78c74113daef4f74aefbc57e92b3a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XUartNs550_GetLastErrors </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This function returns the last errors that have occurred in the specified UART. </p>
<p>It also clears the errors such that they cannot be retrieved again. The errors include parity error, receive overrun error, framing error, and break detection.</p>
<p>The last errors is an accumulation of the errors each time an error is discovered in the driver. A status is checked for each received byte and this status is accumulated in the last errors.</p>
<p>If this function is called after receiving a buffer of data, it will indicate any errors that occurred for the bytes of the buffer. It does not indicate which bytes contained errors.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The last errors that occurred. The errors are bit masks that are contained in the file <a class="el" href="xuartns550_8h.html">xuartns550.h</a> and named XUN_ERROR_*.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a4845a142ff09dda04a0576a11e6bff57">XUartNs550::LastErrors</a>, and <a class="el" href="group__uartns550__v3__3.html#gaf2d9f7f1bffd43b92ef31d187f4bcb5e">XUN_LSR_ERROR_BREAK</a>.</p>

</div>
</div>
<a class="anchor" id="ga541b6125f67b83adfe5f508215d59ea6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XUartNs550_GetModemStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This function gets the modem status from the specified UART. </p>
<p>The modem status indicates any changes of the modem signals. This function allows the modem status to be read in a polled mode. The modem status is updated whenever it is read such that reading it twice may not yield the same results.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance .</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The modem status which are bit masks that are contained in the file <a class="el" href="xuartns550_8h.html">xuartns550.h</a> and named XUN_MODEM_*.</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>The bit masks used for the modem status are the exact bits of the modem status register with no abstraction. </p>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, and <a class="el" href="group__uartns550__v3__3.html#ga69e96899321d1c793301e52cb4ff7d5b">XUN_MSR_OFFSET</a>.</p>

</div>
</div>
<a class="anchor" id="ga120797e7b4fc719c827c4378e387efe4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XUartNs550_GetOptions </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Gets the options for the specified driver instance. </p>
<p>The options are implemented as bit masks such that multiple options may be enabled or disabled simulataneously.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current options for the UART. The optionss are bit masks that are contained in the file <a class="el" href="xuartns550_8h.html">xuartns550.h</a> and named XUN_OPTION_*.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, and <a class="el" href="group__uartns550__v3__3.html#ga3d652c8c88fd310239eab927dff43d94">XUN_FCR_OFFSET</a>.</p>

</div>
</div>
<a class="anchor" id="gad859e54c9baab85a7dd46b6851384ff6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XUartNs550_GetStats </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550_stats.html">XUartNs550Stats</a> *&#160;</td>
          <td class="paramname"><em>StatsPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This functions returns a snapshot of the current statistics in the area provided. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. </td></tr>
    <tr><td class="paramname">StatsPtr</td><td>is a pointer to a <a class="el" href="struct_x_uart_ns550_stats.html" title="UART statistics. ">XUartNs550Stats</a> structure to where the statistics are to be copied to.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550_stats.html#a0ff150c925459d98e4555193e980fbcb">XUartNs550Stats::CharactersReceived</a>, <a class="el" href="struct_x_uart_ns550_stats.html#abd414f52ad160c32832bc17a5451bfef">XUartNs550Stats::CharactersTransmitted</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="struct_x_uart_ns550_stats.html#aa65ee74968a73e8c7b8b218faf5d3530">XUartNs550Stats::ModemInterrupts</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a7346d4d8eba130d8c47c64711edadf98">XUartNs550Stats::ReceiveBreakDetected</a>, <a class="el" href="struct_x_uart_ns550_stats.html#ac33dce22ad55ac46c6ac7abe16500846">XUartNs550Stats::ReceiveFramingErrors</a>, <a class="el" href="struct_x_uart_ns550_stats.html#ab2e33346a9d877573006f4290958922f">XUartNs550Stats::ReceiveInterrupts</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a48bef70419479251de1523a4411615ed">XUartNs550Stats::ReceiveOverrunErrors</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a65f9e1e7119386a2cc91aecd2793474f">XUartNs550Stats::ReceiveParityErrors</a>, <a class="el" href="struct_x_uart_ns550.html#afa9d8ab9f317702502fdc31e6272535a">XUartNs550::Stats</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a9acf15361c4758bf0e0f6f2b8b8e9144">XUartNs550Stats::StatusInterrupts</a>, and <a class="el" href="struct_x_uart_ns550_stats.html#afeb7865c20a883942eb6e5d749c079eb">XUartNs550Stats::TransmitInterrupts</a>.</p>

</div>
</div>
<a class="anchor" id="ga97009bf7b2508c14225b0d5835c256d0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XUartNs550_Initialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Initializes a specific <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance such that it is ready to be used. </p>
<p>The data format of the device is setup for 8 data bits, 1 stop bit, and no parity by default. The baud rate is set to a default value specified by XPAR_DEFAULT_BAUD_RATE if the symbol is defined, otherwise it is set to 19.2K baud. If the device has FIFOs (16550), they are enabled and the a receive FIFO threshold is set for 8 bytes. The default operating mode of the driver is polled mode.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance . </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is the unique id of the device controlled by this <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. Passing in a device id associates the generic <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance to a specific device, as chosen by the caller or application developer.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<ul>
<li>XST_SUCCESS if initialization was successful</li>
<li>XST_DEVICE_NOT_FOUND if the device ID could not be found in the configuration table</li>
<li>XST_UART_BAUD_ERROR if the baud rate is not possible because the input clock frequency is not divisible with an acceptable amount of error</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550___config.html#acfa6708b5ec3e6a3e931d34877447504">XUartNs550_Config::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550___config.html#a4f81c402732b39e1380edbdc8dc42b98">XUartNs550_Config::DefaultBaudRate</a>, <a class="el" href="group__uartns550__v3__3.html#ga37a67d6e3901ba6bee3df7c51dab093b">XUartNs550_CfgInitialize()</a>, and <a class="el" href="group__uartns550__v3__3.html#ga2c5e715e9e90bd93e68c47e1cd398be5">XUartNs550_LookupConfig()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6e8579fcf317e1f30d61b4fb7fe60434"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XUartNs550_InterruptHandler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This function is the interrupt handler for the 16450/16550 UART driver. </p>
<p>It must be connected to an interrupt system by the user such that it is called when an interrupt for any 16450/16550 UART occurs. This function does not save or restore the processor context such that the user must ensure this occurs.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>contains a pointer to the instance of the UART that the interrupt is for.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga36427b607774c1107afd847eb85bc4c9">XUN_IIR_OFFSET</a>, and <a class="el" href="group__uartns550__v3__3.html#ga1770fc9ccf8e1fb1549e53fb83bf2980">XUN_INT_ID_MASK</a>.</p>

</div>
</div>
<a class="anchor" id="gaab822fbaed4a57714779e35b6be6f090"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XUartNs550_IsSending </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This function determines if the specified UART is sending data. </p>
<p>If the transmitter register is not empty, it is sending data.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value of TRUE if the UART is sending data, otherwise FALSE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>, and <a class="el" href="group__uartns550__v3__3.html#ga648b52ef84c2214179e2fe3c80d77677">XUN_LSR_TX_EMPTY</a>.</p>

</div>
</div>
<a class="anchor" id="ga2c5e715e9e90bd93e68c47e1cd398be5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a> * XUartNs550_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Looks up the device configuration based on the unique device ID. </p>
<p>A table contains the configuration info for each device in the system.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>contains the ID of the device to look up the configuration for.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the configuration found or NULL if the specified device ID was not found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__uartns550__v3__3.html#ga5cd4c8bf2383f952ef18132b828636fc">XUartNs550_ConfigTable</a>.</p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga97009bf7b2508c14225b0d5835c256d0">XUartNs550_Initialize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6df754edf91aea638537a15536d4d34e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int XUartNs550_ReceiveBuffer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8c.html">xuartns550.c</a>&gt;</code></p>

<p>This function receives a buffer that has been previously specified by setting up the instance variables of the instance. </p>
<p>This function is designed to be an internal function for the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> component such that it may be called from a shell function that sets up the buffer or from an interrupt handler.</p>
<p>This function will attempt to receive a specified number of bytes of data from the UART and store it into the specified buffer. This function is designed for either polled or interrupt driven modes. It is non-blocking such that it will return if there is no data has already received by the UART.</p>
<p>In a polled mode, this function will only receive as much data as the UART can buffer, either in the receiver or in the FIFO if present and enabled. The application may need to call it repeatedly to receive a buffer. Polled mode is the default mode of operation for the driver.</p>
<p>In interrupt mode, this function will start receiving and then the interrupt handler of the driver will continue until the buffer has been received. A callback function, as specified by the application, will be called to indicate the completion of receiving the buffer or when any receive errors or timeouts occur. Interrupt mode must be enabled using the SetOptions function.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes received.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550_stats.html#a0ff150c925459d98e4555193e980fbcb">XUartNs550Stats::CharactersReceived</a>, <a class="el" href="struct_x_uart_ns550.html#ab54b7f86adf3dc90af130717e7abe1da">XUartNs550::ReceiveBuffer</a>, <a class="el" href="struct_x_uart_ns550.html#afa9d8ab9f317702502fdc31e6272535a">XUartNs550::Stats</a>, <a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, <a class="el" href="group__uartns550__v3__3.html#gae74ee94f0c84de4861c57c04bff0d390">XUN_LSR_BREAK_INT</a>, <a class="el" href="group__uartns550__v3__3.html#ga64e43cf523785c523618adc1f046370f">XUN_LSR_DATA_READY</a>, and <a class="el" href="group__uartns550__v3__3.html#ga0c9f6a9aff7a8753caf9965f3162c2ce">XUN_RBR_OFFSET</a>.</p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv()</a>.</p>

</div>
</div>
<a class="anchor" id="ga35fc171801e394fce29cbcb09dc1ff99"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int XUartNs550_Recv </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>BufferPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>NumBytes</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8c.html">xuartns550.c</a>&gt;</code></p>

<p>This function will attempt to receive a specified number of bytes of data from the UART and store it into the specified buffer. </p>
<p>This function is designed for either polled or interrupt driven modes. It is non-blocking such that it will return if no data has already received by the UART.</p>
<p>In a polled mode, this function will only receive as much data as the UART can buffer, either in the receiver or in the FIFO if present and enabled. The application may need to call it repeatedly to receive a buffer. Polled mode is the default mode of operation for the driver.</p>
<p>In interrupt mode, this function will start receiving and then the interrupt handler of the driver will continue receiving data until the buffer has been received. A callback function, as specified by the application, will be called to indicate the completion of receiving the buffer or when any receive errors or timeouts occur. Interrupt mode must be enabled using the SetOptions function.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. </td></tr>
    <tr><td class="paramname">BufferPtr</td><td>is pointer to buffer for data to be received into </td></tr>
    <tr><td class="paramname">NumBytes</td><td>is the number of bytes to be received. A value of zero will stop a previous receive operation that is in progress in interrupt mode.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes received.</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>The number of bytes is not asserted so that this function may be called with a value of zero to stop an operation that is already in progress. </p>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="struct_x_uart_ns550.html#ab54b7f86adf3dc90af130717e7abe1da">XUartNs550::ReceiveBuffer</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga6df754edf91aea638537a15536d4d34e">XUartNs550_ReceiveBuffer()</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, and <a class="el" href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a>.</p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7f46178664ca6c18e631b64d0dde6e25"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XUartNs550_RecvByte </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>BaseAddress</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8c.html">xuartns550_l.c</a>&gt;</code></p>

<p>This function receives a byte from the UART. </p>
<p>It operates in a polling mode and blocks until a byte of data is received.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the UART.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The data byte received by the UART.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__uartns550__v3__3.html#ga941188ffba023576548effef6ccb0707">XUartNs550_IsReceiveData</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, and <a class="el" href="group__uartns550__v3__3.html#ga0c9f6a9aff7a8753caf9965f3162c2ce">XUN_RBR_OFFSET</a>.</p>

</div>
</div>
<a class="anchor" id="ga2ec86252a3b83b8d7b4815ffb960562d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XUartNs550_SelfTest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This functions runs a self-test on the driver and hardware device. </p>
<p>This self test performs a local loopback and verifies data can be sent and received.</p>
<p>The statistics are cleared at the end of the test. The time for this test to execute is proportional to the baud rate that has been set prior to calling this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<ul>
<li>XST_SUCCESS if the test was successful</li>
<li>XST_UART_TEST_FAIL if the test failed looping back the data</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>This function can hang if the hardware is not functioning properly. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="group__uartns550__v3__3.html#ga67e2cea916214f246e449b8438d01384">XUartNs550_ClearStats()</a>, <a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv()</a>, <a class="el" href="group__uartns550__v3__3.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send()</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a>, <a class="el" href="group__uartns550__v3__3.html#ga64e43cf523785c523618adc1f046370f">XUN_LSR_DATA_READY</a>, <a class="el" href="group__uartns550__v3__3.html#ga04187396f216eb0cd5be0db172fb1934">XUN_MCR_LOOP</a>, and <a class="el" href="group__uartns550__v3__3.html#ga9046de189f3f0a647fc5c908324f31d9">XUN_MCR_OFFSET</a>.</p>

</div>
</div>
<a class="anchor" id="ga421921af6a8df7c51ddbfa5d2301ad1b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int XUartNs550_Send </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>BufferPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>NumBytes</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8c.html">xuartns550.c</a>&gt;</code></p>

<p>This functions sends the specified buffer of data using the UART in either polled or interrupt driven modes. </p>
<p>This function is non-blocking such that it will return before the data has been sent by the UART. If the UART is busy sending data, it will return and indicate zero bytes were sent.</p>
<p>In a polled mode, this function will only send as much data as the UART can buffer, either in the transmitter or in the FIFO if present and enabled. The application may need to call it repeatedly to send a buffer.</p>
<p>In interrupt mode, this function will start sending the specified buffer and then the interrupt handler of the driver will continue sending data until the buffer has been sent. A callback function, as specified by the application, will be called to indicate the completion of sending the buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. </td></tr>
    <tr><td class="paramname">BufferPtr</td><td>is pointer to a buffer of data to be sent. </td></tr>
    <tr><td class="paramname">NumBytes</td><td>contains the number of bytes to be sent. A value of zero will stop a previous send operation that is in progress in interrupt mode. Any data that was already put into the transmit FIFO will be sent.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes actually sent.</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>The number of bytes is not asserted so that this function may be called with a value of zero to stop an operation that is already in progress. <br />
<br />
 This function and the <a class="el" href="group__uartns550__v3__3.html#gac2270082fbb7d7b2c32bd9208dae5be3" title="Sets the options for the specified driver instance. ">XUartNs550_SetOptions()</a> function modify shared data such that there may be a need for mutual exclusion in a multithreaded environment and if <a class="el" href="group__uartns550__v3__3.html#gac2270082fbb7d7b2c32bd9208dae5be3" title="Sets the options for the specified driver instance. ">XUartNs550_SetOptions()</a> if called from a handler. </p>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="struct_x_uart_ns550.html#a6e94aedae6660c25485e826e8488f081">XUartNs550::SendBuffer</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga9046228564fdafeb5715dce1c0b46766">XUartNs550_SendBuffer()</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a>, and <a class="el" href="group__uartns550__v3__3.html#ga8536fc383eb2b08497a576b186547930">XUN_IER_TX_EMPTY</a>.</p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9046228564fdafeb5715dce1c0b46766"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int XUartNs550_SendBuffer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8c.html">xuartns550.c</a>&gt;</code></p>

<p>This function sends a buffer that has been previously specified by setting up the instance variables of the instance. </p>
<p>This function is designed to be an internal function for the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> component such that it may be called from a shell function that sets up the buffer or from an interrupt handler.</p>
<p>This function sends the specified buffer of data to the UART in either polled or interrupt driven modes. This function is non-blocking such that it will return before the data has been sent by the UART.</p>
<p>In a polled mode, this function will only send as much data as the UART can buffer, either in the transmitter or in the FIFO if present and enabled. The application may need to call it repeatedly to send a buffer.</p>
<p>In interrupt mode, this function will start sending the specified buffer and then the interrupt handler of the driver will continue until the buffer has been sent. A callback function, as specified by the application, will be called to indicate the completion of sending the buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NumBytes is the number of bytes actually sent (put into the UART tranmitter and/or FIFO).</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550_stats.html#abd414f52ad160c32832bc17a5451bfef">XUartNs550Stats::CharactersTransmitted</a>, <a class="el" href="struct_x_uart_ns550.html#a6e94aedae6660c25485e826e8488f081">XUartNs550::SendBuffer</a>, <a class="el" href="struct_x_uart_ns550.html#afa9d8ab9f317702502fdc31e6272535a">XUartNs550::Stats</a>, <a class="el" href="group__uartns550__v3__3.html#ga5bbc90c39e15adea04c63548dd537cc5">XUartNs550_GetLineStatusReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga270ca9810a3fde617c7fd9f5bc707e6d">XUN_IER_OFFSET</a>, <a class="el" href="group__uartns550__v3__3.html#gae3baa08e218c2f904b1f28ffd06bc527">XUN_IER_RX_DATA</a>, <a class="el" href="group__uartns550__v3__3.html#ga8536fc383eb2b08497a576b186547930">XUN_IER_TX_EMPTY</a>, <a class="el" href="group__uartns550__v3__3.html#ga36427b607774c1107afd847eb85bc4c9">XUN_IIR_OFFSET</a>, <a class="el" href="group__uartns550__v3__3.html#gad37ac1583a8e7e9f34530947b89e06fe">XUN_INT_ID_FIFOS_ENABLED</a>, <a class="el" href="group__uartns550__v3__3.html#gacfc60ddcada499862b482041805b1f03">XUN_LSR_TX_BUFFER_EMPTY</a>, <a class="el" href="group__uartns550__v3__3.html#ga648b52ef84c2214179e2fe3c80d77677">XUN_LSR_TX_EMPTY</a>, and <a class="el" href="group__uartns550__v3__3.html#gaaeadf9e35937495ade3ac065a4a6ccbf">XUN_THR_OFFSET</a>.</p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send()</a>.</p>

</div>
</div>
<a class="anchor" id="ga08856530b609941a65bb86a2ea1e5f5c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XUartNs550_SendByte </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>BaseAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8c.html">xuartns550_l.c</a>&gt;</code></p>

<p>This function sends a data byte with the UART. </p>
<p>This function operates in the polling mode and blocks until the data has been put into the UART transmit holding register.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the UART. </td></tr>
    <tr><td class="paramname">Data</td><td>contains the data byte to be sent.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__uartns550__v3__3.html#gabae5b671e19c043af9e1c76e183acb60">XUartNs550_IsTransmitEmpty</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, and <a class="el" href="group__uartns550__v3__3.html#gaaeadf9e35937495ade3ac065a4a6ccbf">XUN_THR_OFFSET</a>.</p>

</div>
</div>
<a class="anchor" id="gaaec2dc3c8efd837825dc6c338e2397cc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XUartNs550_SetBaud </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>BaseAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>InputClockHz</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>BaudRate</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__l_8c.html">xuartns550_l.c</a>&gt;</code></p>

<p>Set the baud rate for the UART. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>contains the base address of the UART. </td></tr>
    <tr><td class="paramname">InputClockHz</td><td>is the frequency of the input clock to the device in Hertz. </td></tr>
    <tr><td class="paramname">BaudRate</td><td>is the baud rate to be set.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__uartns550__v3__3.html#gab9ba96c18cb50a8ab5873d781b4ee94e">XUartNs550_GetLineControlReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga4f3ff99ca70dfe6c715cbbfdd9742230">XUartNs550_SetLineControlReg</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga9923a9e780653084f76cd38f4008d0c5">XUN_DRLM_OFFSET</a>, <a class="el" href="group__uartns550__v3__3.html#gad024e52bf451be70a16217ee15136558">XUN_DRLS_OFFSET</a>, and <a class="el" href="group__uartns550__v3__3.html#gaa2aa323315e8d4e0265bcb004debc302">XUN_LCR_DLAB</a>.</p>

</div>
</div>
<a class="anchor" id="ga4b3eb97421a6a66e7029e9afafd8a74b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XUartNs550_SetDataFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550_format.html">XUartNs550Format</a> *&#160;</td>
          <td class="paramname"><em>FormatPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Sets the data format for the specified UART. </p>
<p>The data format includes the baud rate, number of data bits, number of stop bits, and parity. It is the caller's responsibility to ensure that the UART is not sending or receiving data when this function is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance . </td></tr>
    <tr><td class="paramname">FormatPtr</td><td>is a pointer to a format structure containing the data format to be set.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<ul>
<li>XST_SUCCESS if the data format was successfully set.</li>
<li>XST_UART_BAUD_ERROR indicates the baud rate could not be set because of the amount of error with the baud rate and the input clock frequency.</li>
<li>XST_INVALID_PARAM if one of the parameters was not valid.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>The data types in the format type, data bits and parity, are 32 bit fields to prevent a compiler warning that is a bug with the GNU PowerPC compiler. The asserts in this function will cause a warning if these fields are bytes. <br />
<br />
 The baud rates tested include: 1200, 2400, 4800, 9600, 19200, 38400, 57600 and 115200. </p>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550_format.html#a5e0a377a4464adc0e31fb6953e6db5ee">XUartNs550Format::BaudRate</a>, <a class="el" href="struct_x_uart_ns550_format.html#abd1271766499c4ba190318b99bf1a0f5">XUartNs550Format::DataBits</a>, <a class="el" href="struct_x_uart_ns550_format.html#aa3e59ccae311a6e3eb376805c92ffde3">XUartNs550Format::Parity</a>, <a class="el" href="struct_x_uart_ns550_format.html#ad6039467add1a8ec200b25e45538c740">XUartNs550Format::StopBits</a>, <a class="el" href="group__uartns550__v3__3.html#gab9ba96c18cb50a8ab5873d781b4ee94e">XUartNs550_GetLineControlReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga4f3ff99ca70dfe6c715cbbfdd9742230">XUartNs550_SetLineControlReg</a>, <a class="el" href="group__uartns550__v3__3.html#gadde11ab1bed0554bf6863a425a9b6883">XUN_FORMAT_1_STOP_BIT</a>, <a class="el" href="group__uartns550__v3__3.html#ga87a29bbab99baca04a1b2f860000f45d">XUN_FORMAT_2_STOP_BIT</a>, <a class="el" href="group__uartns550__v3__3.html#ga7d074166a6d63f05a7f5b4d8600eef81">XUN_FORMAT_8_BITS</a>, <a class="el" href="group__uartns550__v3__3.html#ga3ceb996b058ef788676793d1da22b4fd">XUN_FORMAT_EVEN_PARITY</a>, <a class="el" href="group__uartns550__v3__3.html#ga12c4007e0384a40140cff2ccd42d20d6">XUN_FORMAT_NO_PARITY</a>, <a class="el" href="group__uartns550__v3__3.html#gac7f9d8d22514af63f22691f8b0aaee5c">XUN_LCR_2_STOP_BITS</a>, <a class="el" href="group__uartns550__v3__3.html#ga4a5273b5f25d43f994d23adcfaceb06f">XUN_LCR_ENABLE_PARITY</a>, <a class="el" href="group__uartns550__v3__3.html#ga5a9981c3534734f46ae6a7761c272cd2">XUN_LCR_EVEN_PARITY</a>, <a class="el" href="group__uartns550__v3__3.html#ga483bdd6c37b57123fdc2a3da8a74a39f">XUN_LCR_LENGTH_MASK</a>, and <a class="el" href="group__uartns550__v3__3.html#gaa87780e1deb82b5068dc0d4f2c495098">XUN_LCR_PARITY_MASK</a>.</p>

</div>
</div>
<a class="anchor" id="gaedd1056b9f1283ee15c1a3c349acb845"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XUartNs550_SetFifoThreshold </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>TriggerLevel</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This functions sets the receive FIFO trigger level. </p>
<p>The receive trigger level specifies the number of bytes in the receive FIFO that cause a receive data event (interrupt) to be generated. The FIFOs must be enabled to set the trigger level.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. </td></tr>
    <tr><td class="paramname">TriggerLevel</td><td>contains the trigger level to set. Constants which define each trigger level are contained in the file <a class="el" href="xuartns550_8h.html">xuartns550.h</a> and named XUN_FIFO_TRIGGER_*.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the trigger level was set</li>
<li>XST_UART_CONFIG_ERROR if the trigger level could not be set, either the hardware does not support the FIFOs or FIFOs are not enabled</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, <a class="el" href="group__uartns550__v3__3.html#ga3d652c8c88fd310239eab927dff43d94">XUN_FCR_OFFSET</a>, <a class="el" href="group__uartns550__v3__3.html#ga729d149d84afe79ed69445f8bf6d5101">XUN_FIFO_ENABLE</a>, <a class="el" href="group__uartns550__v3__3.html#gab75853d561b5a47735a412acc54b1507">XUN_FIFO_RX_TRIGGER</a>, <a class="el" href="group__uartns550__v3__3.html#ga53fffaa233387f3bdc9f8524f4c0498f">XUN_FIFO_TRIGGER_01</a>, <a class="el" href="group__uartns550__v3__3.html#ga098110c073d9bb2840174ec3bfd2d974">XUN_FIFO_TRIGGER_04</a>, <a class="el" href="group__uartns550__v3__3.html#gab3a4c3dc39b03ebc237b78d99980ee53">XUN_FIFO_TRIGGER_08</a>, and <a class="el" href="group__uartns550__v3__3.html#gaa456eb0224a4c1d84177c39e3514d446">XUN_FIFO_TRIGGER_14</a>.</p>

</div>
</div>
<a class="anchor" id="gadf7c4826f92d5e8fd70763f4448a360d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XUartNs550_SetHandler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__uartns550__v3__3.html#ga21a8c40dd3f55a6a052d91bfe2ad8228">XUartNs550_Handler</a>&#160;</td>
          <td class="paramname"><em>FuncPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>This function sets the handler that will be called when an event (interrupt) occurs in the driver. </p>
<p>The purpose of the handler is to allow application specific processing to be performed.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. </td></tr>
    <tr><td class="paramname">FuncPtr</td><td>is the pointer to the callback function. </td></tr>
    <tr><td class="paramname">CallBackRef</td><td>is the upper layer callback reference passed back when the callback function is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>There is no assert on the CallBackRef since the driver doesn't know what it is (nor should it) </p>

<p>References <a class="el" href="struct_x_uart_ns550.html#a9cef284a40cb119ea1528b008f542862">XUartNs550::Handler</a>, and <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="gac2270082fbb7d7b2c32bd9208dae5be3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XUartNs550_SetOptions </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Options</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550_8h.html">xuartns550.h</a>&gt;</code></p>

<p>Sets the options for the specified driver instance. </p>
<p>The options are implemented as bit masks such that multiple options may be enabled or disabled simultaneously.</p>
<p>The GetOptions function may be called to retrieve the currently enabled options. The result is ORed in the desired new settings to be enabled and ANDed with the inverse to clear the settings to be disabled. The resulting value is then used as the options for the SetOption function call.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> instance. </td></tr>
    <tr><td class="paramname">Options</td><td>contains the options to be set which are bit masks contained in the file <a class="el" href="xuartns550_8h.html">xuartns550.h</a> and named XUN_OPTION_*.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the options were set successfully.</li>
<li>XST_UART_CONFIG_ERROR if the options could not be set because the hardware does not support FIFOs</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_uart_ns550.html#a2f39b3adcf6c9cf0b7df4b3a80de3c60">XUartNs550::BaseAddress</a>, <a class="el" href="struct_x_uart_ns550.html#a91623aea4128b71058dba19670cc4b42">XUartNs550::IsReady</a>, <a class="el" href="group__uartns550__v3__3.html#ga58ff500307c70fda263888b18fc6389c">XUartNs550_ReadReg</a>, <a class="el" href="group__uartns550__v3__3.html#gae648146666080fdac4f6949b6ed3101a">XUartNs550_WriteReg</a>, and <a class="el" href="group__uartns550__v3__3.html#ga3d652c8c88fd310239eab927dff43d94">XUN_FCR_OFFSET</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="ga5cd4c8bf2383f952ef18132b828636fc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a> XUartNs550_ConfigTable[]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__g_8c.html">xuartns550_g.c</a>&gt;</code></p>
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line">{</div>
<div class="line">        {</div>
<div class="line">                XPAR_UARTNS550_0_DEVICE_ID,</div>
<div class="line">                XPAR_UARTNS550_0_BASEADDR,</div>
<div class="line">                XPAR_UARTNS550_0_CLOCK_HZ</div>
<div class="line">        }</div>
<div class="line">}</div>
</div><!-- fragment -->
<p>The configuration table for UART 16550/16450 devices in the table. </p>
<p>Each device should have an entry in this table. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga2c5e715e9e90bd93e68c47e1cd398be5">XUartNs550_LookupConfig()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5cd4c8bf2383f952ef18132b828636fc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_uart_ns550___config.html">XUartNs550_Config</a> XUartNs550_ConfigTable[]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xuartns550__i_8h.html">xuartns550_i.h</a>&gt;</code></p>

<p>The configuration table for UART 16550/16450 devices in the table. </p>
<p>Each device should have an entry in this table. </p>

<p>Referenced by <a class="el" href="group__uartns550__v3__3.html#ga2c5e715e9e90bd93e68c47e1cd398be5">XUartNs550_LookupConfig()</a>.</p>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
